🕸️ Ada Research Browser

README.md
Home›Research Reports›README.md
← Back

Compliance Toolkit Documentation

Version: 1.1.0 Last Updated: 2025-10-09

Welcome to the Compliance Toolkit! A comprehensive Windows registry compliance scanner with server/client architecture and web dashboard.

Architecture

The Compliance Toolkit now includes two deployment modes:

Standalone Mode (Original)

Single executable for local compliance scanning and HTML report generation.

go build -ldflags="-s -w" -o ComplianceToolkit.exe ./cmd/toolkit.go

Server/Client Mode (New!)

Centralized compliance monitoring with web dashboard.

Server:

cd cmd/compliance-server
go build -o compliance-server.exe .
./compliance-server.exe --config server.yaml

Client:

cd cmd/compliance-client
go build -o compliance-client.exe .
./compliance-client.exe --config client.yaml --once

Web Dashboard: http://localhost:8443/dashboard

Getting Started

  1. Quick Start Guide - Get up and running in 5 minutes
  2. Installation Guide - Complete installation instructions
  3. User Guide - Interactive mode usage

Server/Client Mode (New!)

Command Line Interface

  1. CLI Quick Start - 5-minute CLI setup
  2. CLI Usage Guide - Complete CLI reference
  3. Automation Examples - Scheduled tasks and scripts

Reports & Compliance

  1. Available Reports - All compliance reports
  2. Evidence Logging - Audit trail documentation
  3. Executive Reports - C-level reporting features

Advanced Usage

  1. Adding New Reports - Create custom reports
  2. Template System - HTML template customization
  3. Configuration Reference - JSON configuration format

Developer Resources

  1. Architecture Overview - Codebase structure
  2. Development Guide - Building and contributing
  3. Project Status - Current features and roadmap

For End Users:

For IT Administrators:

For Developers:

What is Compliance Toolkit?

The Compliance Toolkit is a comprehensive Windows registry compliance scanner with:

Standalone Features

Server/Client Features (New!)

Quick Start

The fastest way to get started is using Docker:

# Clone the repository
git clone https://github.com/MrBrooks-code/compliance-toolkit.git
cd compliance-toolkit

# Build and run with Docker Compose
docker-compose up -d

# Access the web dashboard
http://localhost:8080/login

Default credentials: - Username: admin - Password: admin123

What you get: - ✅ Web dashboard at http://localhost:8080 - ✅ JWT Authentication - ✅ RESTful API for compliance submissions - ✅ Automatic container restart on failure

Useful commands:

# View logs
docker-compose logs -f

# Stop the server
docker-compose down

# Rebuild after changes
docker-compose up --build -d

🖥️ Standalone Mode (Local Scanning)

Interactive Mode:

ComplianceToolkit.exe
# Select [1] Run Reports
# Choose a report
# View results in browser

Command Line Mode:

# List available reports
ComplianceToolkit.exe -list

# Run a single report
ComplianceToolkit.exe -report=NIST_800_171_compliance.json

# Run all reports (for scheduled tasks)
ComplianceToolkit.exe -report=all -quiet

Server/Client Mode (Manual Deployment)

1. Start Server:

cd cmd/compliance-server
./compliance-server.exe --config server.yaml

2. Run Client (send compliance data):

./compliance-client.exe --config client.yaml --once

3. Access Web Dashboard:

http://localhost:8443/dashboard

Documentation Structure

docs/
├── README.md (this file)
├── user-guide/
│   ├── QUICKSTART.md              # 5-minute getting started
│   ├── INSTALLATION.md            # Installation instructions
│   ├── USER_GUIDE.md              # Interactive mode guide
│   ├── CLI_QUICKSTART.md          # CLI quick start
│   ├── CLI_USAGE.md               # Complete CLI reference
│   └── AUTOMATION.md              # Automation examples
├── developer-guide/
│   ├── ARCHITECTURE.md            # Codebase overview
│   ├── DEVELOPMENT.md             # Build and contribute
│   ├── ADDING_REPORTS.md          # Create custom reports
│   └── TEMPLATES.md               # Template system
├── reference/
│   ├── REPORTS.md                 # Available reports
│   ├── EVIDENCE.md                # Evidence logging
│   ├── EXECUTIVE.md               # Executive reports
│   └── CONFIG.md                  # Configuration format
└── PROJECT_STATUS.md              # Project status and roadmap

Getting Help

Common Issues

"configs/reports not found" - Solution: Ensure configs/reports/*.json exists next to the executable - See: Installation Guide

"Access denied" errors - Solution: Run as Administrator - See: Installation Guide

Reports not opening - Solution: Clear browser cache and regenerate report - See: User Guide

Need More Help?

Updates & Versions

Current Version: 1.1.0

Recent Updates (Phase 3.2 - Full Web UI): - ✅ Server/Client Architecture - Centralized compliance monitoring - ✅ Web Dashboard - Real-time stats with recent submissions and clients - ✅ Clients Page - Full client list with search, filtering, sorting, and pagination - ✅ Client Detail Page - Complete client history with compliance trend charts - ✅ Submission Detail Page - Full compliance check details with evidence - ✅ Policies Page - Import and manage compliance policies - ✅ Settings Page - User management, API keys, server configuration - ✅ About Page - Project information and GitHub repository link - ✅ Cookie-based Authentication - Secure token management - ✅ Dark/Light Theme - System-wide theme support with smooth transitions - ✅ Docker Support - One-command deployment with Docker Compose - ✅ Export Functionality - JSON downloads for all data - ✅ Auto-refresh Dashboard - 30-second update intervals

Previous Updates: - ✅ CLI automation support - ✅ Scheduled task examples - ✅ Smart path resolution - ✅ Dark mode improvements - ✅ Search functionality

Roadmap

Completed (Phase 3.1): - ✅ Client Detail Page (#2) - ✅ Submission Detail Page (#1) - ✅ Settings Page (#4)

Upcoming (Phase 3.2): - 🔜 Login/Authentication Page (#3) - 🔜 Reports & Analytics (#4) - 🔜 Alerts & Notifications (#6)

See Future Enhancements for complete roadmap.

Interface

Login Page

Login Page

Secure authentication with customizable login banner and theme support.

Dashboard

Dashboard

Real-time monitoring with compliance stats, recent submissions, and recent clients overview.

Clients Page

Clients Page

Full client list with advanced search, filtering by status/compliance, sortable columns, and pagination.

Client Detail Page

Client Detail

Complete client history with system information, compliance trend chart, and detailed submission history.

Submission Detail Page

Submission Detail

Full compliance check results with passed/failed status, registry paths, and evidence records.

Policies Page

Policies Page

Import and manage compliance policies with search and filtering capabilities.

Settings Page

Settings Page

Manage users, API keys, server configuration, and customize login messages.

About Page

About Page

Project information, GitHub repository link, and documentation resources.

Documentation Version: 1.2 Last Updated: 2025-10-09